Skip to main content

5. Custom Actions

default_interface_of_custom_actions

Figure: Default Interface of Custom Actions

Field/ButtonDescription
SearchSearches the created custom actions
+ Create ActionCreates a new custom action

Table: Fields and Buttons in Custom Action Interface

5.1. Step 1 of Custom Action Creation

step_1_of_2_interface_in_custom_action_creation

Figure: Step 1 of 2 Interface in Custom Action Creation

Field/ButtonDescription
Action NameDefines the action name
Action DescriptionProvides a short description explaining when and why this custom action should be used
How Often to Show This Action After the ConversationDefines how frequently to display the action after the conversation
Enable This ActionEnables the action to trigger
ContinueProceeds to Step 2
Table: Fields and Buttons in Step 1 of Custom Action Interface

5.2. Step 2 of Custom Action Creation

There are three types of custom actions:

  • URL Link – Redirects users to an external or internal URL when triggered.
  • Contact Form – Collects user contact information through a predefined form.
  • Custom Form – Captures structured, user-defined data based on configurable form fields.
Fields/ButtonDescription
Button LabelProvides the label of the button to display on the action button in the user interface
Redirect URLProvides the desired URL link
Go BackReturns to Step 1 of custom action creation
Table: URL Link Fields and Buttons in the Setup Custom Action Interface

step_2_of_2_interface_in_custom_action_creation

Figure: Step 2 of 2 Interface in Custom Action Creation

success_message_after_url_link_is_created_by_clicking_create_action

Figure: Success Message After URL Link Is Created by Clicking Create Action

Fields/ButtonDescription
Active (Toggle switch)Enables or disables the configured URL Link custom action
Edit IconManages the configured URL Link custom action
Delete IconDeletes the configured URL Link custom action
Save ChangesSaves the updates of the configured URL Link custom action
Table: Options Available for the Configured URL Link Custom Action

The Screen after clicking Edit Icon

Figure: The Screen After Clicking Edit Icon

the_screen_after_clicking_delete_icon

Figure: The Screen After Clicking Delete Icon

2. Contact Form

The Contact Form custom action consists of three main sections.

SectionsDescription
Form DetailsProvides general information about the contact form action
Form FieldsUses the predefined input fields that will be displayed to users
IntegrationConfigures the API call that will be triggered when the form is submitted
Table: Sections Under the Contact Form Custom Action

contact_form_interface

Figure: Contact Form Interface

2.1. Form Details

FieldsDescription
Form TitleProvides the title of the contact form
Form DescriptionProvides the description of the contact form
Submission Success MessageProvides the submission success message of the contact form
Form Submission Button LabelProvides the label of the button to display on the action button in the user interface
Table: Fields Under Form Details

2.2. Form Fields

The contact form includes four predefined fields:

  • Name
  • Email
  • Phone
  • Description

2.3. Integration

api_request_section

Figure: API Request Section

The API Request defines how form data is sent to an external system when the contact form is submitted.

Methods/ComponentsDescription
GETRetrieves data from the external system or server
POSTSends data to the external system or server
ParameterFilters, searches, or passes simple data to the external system or server
HeaderProvides additional information required by the external system or server to correctly process the request
BodySends structured data, such as form submissions or JSON objects
Table: Methods and Components in the API Request Section

3. Custom Form

The Custom Form custom action consists of three main sections.

SectionsDescription
Basic InformationProvides general information about the custom form action
Custom Form FieldsAdds the custom input fields that will be displayed to users
IntegrationConfigures the API call that will be triggered when the form is submitted
Table: Sections Under the Custom Form Custom Action

custom_form_interface

Figure: Custom Form Interface

3.1. Basic Information

Fields/ButtonDescription
Form TitleProvides the title of the custom form
Form DescriptionProvides the description of the custom form
Form Submission MessageProvides the submission success message of the custom form
Button LabelProvides the label of the button to display on the action button in the user interface
Table: Fields Under Overview Section

3.2. Custom Form Fields

ButtonDescription
+ Add FieldAdds the custom form fields

Table: Button in the Form Fields

Step 1: Click +Add in the Custom Form Fields of Custom Action The system displays the added form field.

the_custom_form_fields_section_after_clicking_add_button

Figure: The Custom Form Fields Section After Clicking "+Add" Button

IconsDescription
Check Box Icon for RequiredDefines whether the field is mandatory or optional
Edit IconEdits form fields
Delete IconDeletes the added form fields
Table: Icons Available in the Added Custom Form Fields

Step 2: Click Edit Icon on the added form field The system shows the Edit Form Field pop-up.

edit_form_field_with_text_field_type_default

Figure: Edit Form Field with Text Field Type (Default)

NoField Type
1.Text
2.Email
3.Phone
4.Number
5.Text Area
6.Dropdown
7.Checkbox

Table: Field Types Available in the Edit Form Field

ButtonsDescription
SaveSaves the update or edit information in the edit form field
Cross iconCancels the form field editing process
Table: Buttons Available in the Edit Form Field Pop-up
For Text Field Type:
FieldsDescription
Field TypeSelects the type of input field (e.g., Text, Number, Email) that determines how data is entered and validated
LabelDefines the display name of the form field shown to end users
PlaceholderSpecifies the hint text displayed inside the field to guide users on what to enter
Default ValueSets a pre-filled value that appears in the field when the form is loaded
Error MessageProvides the error message
Table: Available Fields for the Text Field Type

edit_form_field_for_text_field_type

Figure: Edit Form Field for Text Field Type

For Email Field Type:
FieldsDescription
Field TypeSelects the type of input field (e.g., Text, Number, Email) that determines how data is entered and validated
LabelDefines the display name of the form field shown to end users
PlaceholderSpecifies the hint text displayed inside the field to guide users on what to enter
Default ValueSets a pre-filled value that appears in the field when the form is loaded
Error MessageProvides the error message
Table: Available Fields for the Email Field Type

edit_form_field_for_email_field_type

Figure: Edit Form Field for Email Field Type

For Phone Field Type:
FieldsDescription
Field TypeSelects the type of input field (e.g., Text, Number, Email) that determines how data is entered and validated
LabelDefines the display name of the form field shown to end users
PlaceholderSpecifies the hint text displayed inside the field to guide users on what to enter
Default ValueSets a pre-filled phone number that appears in the field when the form is loaded
Error MessageProvides the error message
Table: Available Fields for the Phone Field Type

edit_form_field_for_phone_field_type

Figure: Edit Form Field for Phone Field Type

For Text Area Field Type:
FieldsDescription
Field TypeSelects the type of input field (e.g., Text, Number, Email) that determines how data is entered and validated
LabelDefines the display name of the form field shown to end users
PlaceholderSpecifies the hint text displayed inside the field to guide users on what to enter
Default ValueSets a pre-filled value that appears in the field when the form is loaded
Error MessageProvides the error message
Table: Available Fields for the Text Area Field Type

edit_form_field_for_text_area_field_type

Figure: Edit Form Field for Text Area Field Type

For Number Field Type:
FieldsDescription
Field TypeSelects the type of input field (e.g., Text, Number, Email) that determines how data is entered and validated
LabelDefines the display name of the form field shown to end users
PlaceholderSpecifies the hint text displayed inside the field to guide users on what to enter
Default ValueSets a pre-filled value that appears in the field when the form is loaded
Error MessageProvides the error message
Table: Available Fields for the Number Field Type

edit_form_field_for_number_field_type

Figure: Edit Form Field for Number Field Type

For Dropdown Field Type:
Fields/ButtonDescription
Field TypeSelects the type of input field (e.g., Text, Number, Email) that determines how data is entered and validated
LabelDefines the display name of the form field shown to end users
Option ListSelects one option in the custom form
Error MessageProvides the error message
+AddAdds the option list
Delete IconDeletes or removes the option list
Table: Available Fields and Buttons for the Dropdown Field Type

edit_form_field_for_dropdown_field_type

Figure: Edit Form Field for Dropdown Field Type

edit_form_field_for_dropdown_field_type_after_clicking_add_button

Figure: Edit Form Field for Dropdown Field Type after Clicking "+Add" Button

edit_form_field_for_dropdown_field_type_after_clicking_delete_icon_on_option2

Figure: Edit Form Field for Dropdown Field Type after Clicking the Delete Icon on Option2

For Checkbox Field Type:
Fields/ButtonDescription
Field TypeSelects the type of input field (e.g., Text, Number, Email) that determines how data is entered and validated
LabelDefines the display name of the form field shown to end users
Option ListSelects one option in the custom form
Error MessageProvides the error message
+AddAdds the option list
Delete IconDeletes or removes the option list
Table: Available Fields and Buttons for the Checkbox Field Type

edit_form_field_for_checkbox_field_type

Figure: Edit Form Field for Checkbox Field Type

edit_form_field_for_checkbox_field_type_after_clicking_add_button

Figure: Edit Form Field for Checkbox Field Type after Clicking "+Add" Button

edit_form_field_for_checkbox_field_type_after_clicking_delete_icon_on_option2

Figure: Edit Form Field for Checkbox Field Type after Clicking the Delete Icon on Option2

3.4. Custom Form Integration

api_request_section2

Figure: API Request Section

The API Request defines how form data is sent to an external system when the custom form is submitted.

Methods/ComponentsDescription
GETRetrieves data from the external system or server
POSTSends data to the external system or server
ParameterFilters, searches, or passes simple data to the external system or server
HeaderProvides additional information required by the external system or server to correctly process the request
BodySends structured data, such as form submissions or JSON objects
Table: Methods and Components in the API Request Section

4. API Integration

The API Integration defines how form data is sent to an external system when the custom form is submitted.

Methods/ComponentsDescription
GETRetrieves data from the external system or server
POSTSends data to the external system or server
ParameterFilters, searches, or passes simple data to the external system or server
HeaderProvides additional information required by the external system or server to correctly process the request
BodySends structured data, such as form submissions or JSON objects
Table: Methods and Components in the API Integration Section

integration_section

Figure: Integration Section

custom_actions_interface_after_contact_form_and_custom_form_are_created

Figure: Custom Actions Interface After Contact Form and Custom Form Are Created